Skip to content

fix: restore reserved suffix stripping in PrometheusNaming.sanitizeMetricName()#2124

Merged
zeitlinger merged 1 commit into
prometheus:mainfrom
zeitlinger:fix/sanitize-metric-name-reserved-suffix
May 20, 2026
Merged

fix: restore reserved suffix stripping in PrometheusNaming.sanitizeMetricName()#2124
zeitlinger merged 1 commit into
prometheus:mainfrom
zeitlinger:fix/sanitize-metric-name-reserved-suffix

Conversation

@zeitlinger
Copy link
Copy Markdown
Member

Fixes #2087.

Supersedes #2094 with the same fix on a clean, signed-off commit so the DCO
check can pass.

sanitizeMetricName() was simplified in 1.6.0 to return its input unchanged
because any non-empty UTF-8 string is now a valid metric name. That silently
broke downstream tools — notably the JMX Exporter and the simpleclient bridge —
that call sanitizeMetricName() to normalize external names before passing them
to snapshot builders.

The missing stripping means a JMX attribute that produces
kafka_consumer_request_total as a raw name is no longer sanitized to
kafka_consumer_request. With inferCounterTypeFromName: true this triggers
unintended counter-type inference; with it false the metric is stored under the
wrong name, breaking exact-name registry lookups.

Changes

  • Restore RESERVED_METRIC_NAME_SUFFIXES and the iterative suffix-stripping loop
    in PrometheusNaming.sanitizeMetricName().
  • Keep the exact-match case, for example "_total" -> "total", in a dedicated
    pre-pass before the stripping loop.
  • Update PrometheusNamingTest and MetricMetadataTest expectations.
  • Add regression coverage for the JMX Exporter scenario and dot-variant corner
    case, for example .total.
// Before fix: suffix preserved -> metric stored as "kafka_consumer_request_total"
PrometheusNaming.sanitizeMetricName("kafka_consumer_request_total");

// After fix: suffix stripped -> metric stored as "kafka_consumer_request"
PrometheusNaming.sanitizeMetricName("kafka_consumer_request_total");

Counter.builder().name("events_total") is unaffected because the builder API
does not go through sanitizeMetricName().

Validation

  • mise run build

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@zeitlinger zeitlinger merged commit 2d0f508 into prometheus:main May 20, 2026
10 checks passed
@zeitlinger zeitlinger deleted the fix/sanitize-metric-name-reserved-suffix branch May 20, 2026 09:53
zeitlinger added a commit that referenced this pull request May 22, 2026
Draft validation PR for the unmodified Micrometer compatibility story.

This intentionally does **not** depend on #2114. Vanilla Micrometer does
not use
the typed descriptor API and does not implement the #1800 registration
metadata
hooks, so this PR validates the patch-compatible path independently of
typed
descriptors.

This validates upstream `micrometer-metrics/micrometer@main` against:

- current `main`, which already includes #2100 and #2124 (reserved
suffix
  stripping in `PrometheusNaming.sanitizeMetricName()`).
- Micrometer compatibility test tooling/workflow from
zeitlinger#1.

Local validation:

- `mise run lint`
- `MICROMETER_DIR=/tmp/micrometer-compat-vanilla-2124 mise run
micrometer:test`

---------

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Co-authored-by: Jay DeLuca <jaydeluca4@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Counter name/type inference changed in 1.6.1 for untyped metrics, breaking downstream expectation of UNKNOWN

2 participants